Package-level declarations

Types

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class ReplaceStickerInSetAction(userId: Long, name: String, oldSticker: String, sticker: InputSticker) : Action<Boolean>
Link copied to clipboard
Link copied to clipboard
class SetStickerKeywordsAction(sticker: String, keywords: List<String>? = null) : SimpleAction<Boolean>
Link copied to clipboard
class SetStickerMaskPositionAction(sticker: String, maskPosition: MaskPosition? = null) : SimpleAction<Boolean>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class UploadStickerFileAction(sticker: InputFile, stickerFormat: StickerFormat) : MediaAction<File>

Functions

Link copied to clipboard

Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns True on success.

inline fun addStickerToSet(name: String, input: () -> InputSticker): AddStickerToSetAction
Link copied to clipboard

Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. Returns True on success.

Link copied to clipboard

Use this method to delete a sticker from a set created by the bot. Returns True on success.

Link copied to clipboard

Use this method to delete a sticker set that was created by the bot. Returns True on success.

Link copied to clipboard
@JvmName(name = "getCustomEmojiStickersWithVararg")
inline fun getCustomEmojiStickers(vararg customEmojiId: String): GetCustomEmojiStickersAction

Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.

Link copied to clipboard

Use this method to get a sticker set. On success, a StickerSet object is returned.

Link copied to clipboard
inline fun replaceStickerInSet(userId: Long, name: String, oldSticker: String, sticker: InputSticker): ReplaceStickerInSetAction

Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling deleteStickerFromSet, then addStickerToSet, then setStickerPositionInSet. Returns True on success.

Link copied to clipboard

Use this method to set the thumbnail of a custom emoji sticker set. Returns True on success.

Link copied to clipboard

Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.

Link copied to clipboard
inline fun setStickerKeywords(sticker: String, keywords: List<String>? = null): SetStickerKeywordsAction

Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns True on success.

Link copied to clipboard
inline fun setStickerMaskPosition(sticker: String, maskPosition: MaskPosition? = null): SetStickerMaskPositionAction

Use this method to change the mask position of a mask sticker. The sticker must belong to a sticker set that was created by the bot. Returns True on success.

Link copied to clipboard

Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.

Link copied to clipboard

Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns True on success.

Link copied to clipboard

Use this method to set the title of a created sticker set. Returns True on success.

Link copied to clipboard

Use this method to upload a file with a sticker for later use in the createNewStickerSet, addStickerToSet, or replaceStickerInSet methods (the file can be used multiple times). Returns the uploaded File on success.